.TH cps_set_oid.oy "1" "2018-06-11" OPX "OPX utilities"
.SH NAME
cps_set_oid.py \- Send CPS API set request
.SH SYNOPSIS
.SY cps_set_oid.py
.OP \-h
.OP \-\-help
.OP \-qua qualifier
.OP \-d
\fB\-oper\fR \fIoperation\fR
.I object
.RI [ attr = value
.IR .\|.\|. ]
.YS
.SH DESCRIPTION
This command allows the user to perform CPS API transaction, specified by \fIoperation\fR, which must be one of: create, set, delete, or action.
.P
The object \fIobject\fR is specified as a slash-separated pathname of the form a/b/c/..., much like a Unix pathname.  Object names are defined by the CPS API YANG models.
.P
A sequence of object attributes, in the form \fIattr\fR=\fIvalue\fR can be specified, to specify values for object attributes in the CPS API SET request.  Attributes names are of the same form as object names, a slash-separated pathname.
.SH OPTIONS
.TP
.B \-h, \-\-help
Print help text.
.TP
\fB\-qua\fR \fIqualifier\fR
Specify the CPS API object qualifier in the request.  The qualifier is a string, and must be one of the following: target, observed, proposed, realtime, registration, running, or startup.  If this option is not given, the default qualifier is target.
.TP
.B \-d
Print additional details about the objects parsed and sent to the backend.
.SH EXAMPLE
.nf
.eo
# Set the MTU of an interface

root@OPX:~# cps_get_oid.py dell-base-if-cmn/if/interfaces/interface dell-base-if-cmn/if/interfaces/interface/if-index=11

============dell-base-if-cmn/if/interfaces/interface==========

base-if-phy/if/interfaces/interface/npu-id = 0
dell-base-if-cmn/if/interfaces/interface/if-index = 11
dell-if/if/interfaces/interface/phys-address = 00:0c:29:5d:8e:a3
dell-if/if/interfaces/interface/speed = 0
if/interfaces/interface/enabled = 0
base-if-phy/if/interfaces/interface/learn-mode = 3
if/interfaces/interface/name = e101-001-0
dell-if/if/interfaces/interface/duplex = 1
dell-if/if/interfaces/interface/auto-negotiation = 0
if/interfaces/interface/type = ianaift:ethernetCsmacd
dell-if/if/interfaces/interface/tx-idle-time = 2560
dell-if/if/interfaces/interface/oui = 6976381
dell-if/if/interfaces/interface/tx-wake-time = 2560
dell-if/if/interfaces/interface/mode = 1
base-if-phy/if/interfaces/interface/port-id = 25
dell-if/if/interfaces-state/interface/supported-speed = 3,4,6
dell-if/if/interfaces/interface/mtu = 1532
base-if-phy/if/interfaces/interface/phy-media = 2
dell-if/if/interfaces/interface/fec = 2
base-if-phy/if/interfaces/interface/tagging-mode = 3
dell-if/if/interfaces/interface/eee = 0
------------------------------------------------

root@OPX:~# cps_set_oid.py -oper set dell-base-if-cmn/if/interfaces/interface dell-base-if-cmn/if/interfaces/interface/if-index=11 dell-if/if/interfaces/interface/mtu=9000
Success
Key: 1.19.44.2883617.2883612.2883613.
dell-if/if/interfaces/interface/mtu = 9000
dell-base-if-cmn/if/interfaces/interface/if-index = 11
cps/object-group/return-code = 0

root@OPX:~# cps_get_oid.py dell-base-if-cmn/if/interfaces/interface dell-base-if-cmn/if/interfaces/interface/if-index=11

============dell-base-if-cmn/if/interfaces/interface==========

base-if-phy/if/interfaces/interface/npu-id = 0
dell-base-if-cmn/if/interfaces/interface/if-index = 11
dell-if/if/interfaces/interface/phys-address = 00:0c:29:5d:8e:a3
dell-if/if/interfaces/interface/speed = 0
if/interfaces/interface/enabled = 0
base-if-phy/if/interfaces/interface/learn-mode = 3
if/interfaces/interface/name = e101-001-0
dell-if/if/interfaces/interface/duplex = 1
dell-if/if/interfaces/interface/auto-negotiation = 0
if/interfaces/interface/type = ianaift:ethernetCsmacd
dell-if/if/interfaces/interface/tx-idle-time = 2560
dell-if/if/interfaces/interface/oui = 6976381
dell-if/if/interfaces/interface/tx-wake-time = 2560
dell-if/if/interfaces/interface/mode = 1
base-if-phy/if/interfaces/interface/port-id = 25
dell-if/if/interfaces-state/interface/supported-speed = 3,4,6
dell-if/if/interfaces/interface/mtu = 9000
base-if-phy/if/interfaces/interface/phy-media = 2
dell-if/if/interfaces/interface/fec = 2
base-if-phy/if/interfaces/interface/tagging-mode = 3
dell-if/if/interfaces/interface/eee = 0
------------------------------------------------
.ec
.fi
.SH REPORTING BUGS
To report any OPX software bugs, please refer to https://github.com/open-switch/opx-docs/wiki/Report-bugs.
.SH COPYRIGHT
Copyright \(co 2018 Dell Inc. and its subsidiaries. All Rights Reserved.
.SH SEE ALSO
cps_model_info(1)
